Get Recipient

get

https://sandbox-api.readyremit.com/v1/recipients/{recipientId}

The GET /recipients/{recipientId} endpoint retrieves the details of a specific recipient record. This operation is essential for fetching the complete information of a recipient, including their personal details and any additional fields.

Implementation Guide:

Ensure that the recipientId parameter is correctly formatted and corresponds to an existing recipient record.
Use this endpoint to fetch complete recipient details, which can be used for displaying information in user interfaces or for verifying recipient details before performing other operations.

Responses

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The request was successful, and the response contains the complete details of the recipient.

400The request was invalid. This response typically occurs if the recipientId parameter is missing or invalid.

401The request requires user authentication. This response occurs if the authentication token is missing or invalid.

403The request was valid, but the server is refusing action. This response occurs if the user does not have permission to access the recipient record.

404The specified recipient record was not found. This response occurs if the recipientId does not match any existing recipient records.