Update an existing payout partner

Forex

Operations

Payout Partner

Operations

Returns all existing payout partners

Request

Returns a list of all existing payout partners

Security

oauth2

curl -i -X GET \
  https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/payout_partners \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns a list of all existing payout partners

Bodyapplication/jsonArray [

idstring(uuid)required

namestringrequired

display_namestringrequired

typestringrequired

Enum"NON_EXCHANGE""EXCHANGE"

statusstringrequired

Enum"ACTIVE""DISABLED""DELETED"

]

Response

application/json

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "display_name": "string",
    "type": "NON_EXCHANGE",
    "status": "ACTIVE"
  }
]

Create a new payout partner

Request

Returns the id and status of the created payout partner, along with the original names from the request

Security

oauth2

Bodyapplication/jsonrequired

The payout partner to create.

namestringrequired

display_namestringrequired

typestringrequired

Enum"NON_EXCHANGE""EXCHANGE"

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/payout_partners \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "display_name": "string",
    "type": "NON_EXCHANGE"
  }'

Responses

Returns details about the created payout partner

Bodyapplication/json

idstring(uuid)required

namestringrequired

display_namestringrequired

typestringrequired

Enum"NON_EXCHANGE""EXCHANGE"

statusstringrequired

Enum"ACTIVE""DISABLED""DELETED"

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "display_name": "string",
  "type": "NON_EXCHANGE",
  "status": "ACTIVE"
}

Delete an existing payout partner

Request

The payout partner's status would be changed from ACTIVE to DELETED

Security

oauth2

Path

partner_idstring(uuid)required

The id of the payout partner to delete.

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/payout_partners/{partner_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully deleted the payout partner

Body

Response

No content

Get details about an existing payout partner

Request

Returns the details about the payout partner

Security

oauth2

Path

partner_idstring(uuid)required

The id of the payout partner to retrieve.

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/payout_partners/{partner_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns the details about the payout partner

Bodyapplication/json

idstring(uuid)required

namestringrequired

display_namestringrequired

typestringrequired

Enum"NON_EXCHANGE""EXCHANGE"

statusstringrequired

Enum"ACTIVE""DISABLED""DELETED"

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "display_name": "string",
  "type": "NON_EXCHANGE",
  "status": "ACTIVE"
}