Skip to content

Payout service APIs (1.0.0)

Payout service APIs

Overview
E-mail
kjakkula@ripple.com
License
Apache 2.0
Terms of Service
Languages
Servers
Mock server
https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service

Payout Partner

Operations

Payout Method

Operations

Data requirements

Operations

Payouts

Operations

PayoutsV2

Operations

Quotes

Operations

Webhooks

Operations

Tranglo

Operations

A webhook endpoint for Tranglo to POST the updated status of payout

Request

This is an webhook endpoint hosted by payout service so that Tranglo can call us back with the updated status of payout. The API then updates the status of payout within the payout service and optionally will callback any upstream services like payments service with the new status.

Bodyapplication/jsonrequired
checksumstringrequired

checksum from Tranglo

Example: "checksum"
app_keystringrequired

A unique app key generated by payout service.

Example: "app_key"
Datestringrequired

Time that webhook for payout update status request was triggered from Tranglo using the format dd-mm-yyyy HH:mm:ss

Example: "Date"
from_balancestringrequired

Pool balance before transaction

Example: "from_balance"
to_balancestringrequired

Pool balance after transaction

Example: "to_balance"
trxStatusobject

TransactionStatus object that holds the 3 digit transaction code, type and status from Tranglo

Example: {"Status":"Status","Type":null,"Value":0,"Remark":"Remark"}
Valueinteger

3 digit transaction response code. See https://tranglo.com/docs/tranglo-connect/request-response-code-description/transaction-status/

Typestring
Enum"Pending""Approved""Declined""Suspected""Error"
Statusstring

Description of the transaction status

Example: "Status"
Remarkstring

A comment explaining the transaction status

Example: "Remark"
transIDstringrequired

Transaction id generated by payout service

Example: "transID"
GTNstringrequired

Transaction id generated by Tranglo

Example: "GTN"
GTNMAstring

Tranglo manual adjustment transaction id. This is an optional field that will be returned when an adjustment is made

Example: "GTNMA"
txCreateDateTimestringrequired

The datetime when the transaction was recorded by Tranglo

Example: "txCreateDateTime"
txUpdateDateTimestringrequired

The datetime when the transaction was last updated

Example: "txUpdateDateTime"
Descriptionstringrequired

Transaction description or advice from Tranglo

Example: "Description"
PayoutIDstring

Payout ID from cash out supplier

Example: "PayoutID"
PayoutPinstring

Payout PIN from cash out supplier

Example: "PayoutPin"
PayoutStatusstring
Enum"Claimed""Inprocess""Outstanding""Cancelled"
PayoutStatusUpdateTimestring

Payout status update date time

Example: "PayoutStatusUpdateTime"
curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/webhooks/tranglo/payout_status \
  -H 'Content-Type: application/json' \
  -d '{
    "GTN": "GTN",
    "Description": "Description",
    "PayoutStatus": null,
    "transID": "transID",
    "PayoutID": "PayoutID",
    "trxStatus": {
      "Status": "Status",
      "Type": null,
      "Value": 0,
      "Remark": "Remark"
    },
    "txCreateDateTime": "txCreateDateTime",
    "Date": "Date",
    "app_key": "app_key",
    "to_balance": "to_balance",
    "PayoutStatusUpdateTime": "PayoutStatusUpdateTime",
    "from_balance": "from_balance",
    "checksum": "checksum",
    "PayoutPin": "PayoutPin",
    "GTNMA": "GTNMA",
    "txUpdateDateTime": "txUpdateDateTime"
  }'

Responses

This means the payout state was received and updated successfully. Required by Tranglo to ack the receipt of payout status.

Body

Data Requirement

Operations