This endpoint is used to request a recommendation when making a payout to a supplier.
To request a recommendation at this endpoint use the payout checkpoint. Ravelin will then return a recommendation of ALLOW, REVIEW or PREVENT.
The time at which this data payload was valid. When sending events in realtime, this will usually be 'now'. This is used to merge data that arrives out-of-order. A unix timestamp preferably as an
integer count of milliseconds since |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
The payout describing the earnings that a merchant is intended to pay to the supplier on their platform. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
The supplier that is set as the recipient of this payout. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
An eventType should identify what event in your system triggered this API call. Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-_]*$ |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
A primary payout method for funds to be transferred in by the merchant. One of the following:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
Removal: Used for marking a saved payment method as removed from the account. Show definition |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
A primary payout method for funds to be transferred in by the merchant. |
POST https://api.ravelin.com/v2/payout HTTP/1.1
Authorization: token ...
Content-Type: application/json
{
"timestamp": 1512828988826,
"payout": {
"payoutId": "abc-123-ZYZ",
"status": "CREATED",
"earnings": {
"currency": "GBP",
"totalGrossAmount": 6000,
"baseAmount": 1000,
"compensationAmount": 200,
"bonusAmount": 800,
"withheldTaxAmount": 5000,
"onPlatformRevenue": 9000,
"totalNetAmount": 6000,
"feeAmount": 6000
},
"revenueSource": {
"ads": 1000,
"referral": 2000,
"promo": 3000,
"subscriptions": 1500,
"purchase": 2500,
"others": 0
},
"periodStart": 1667260800000,
"periodEnd": 1669852800000,
"creationTime": 1512828988826,
"payoutTime": 1512828988826,
"schedule": "MONTHLY",
"initiatedBy": "SUPPLIER",
"notificationEmail": "jsmith123@example.com"
},
"supplier": {
"supplierId": "abc-123-ZYZ",
"groupId": "abc-123",
"groupName": "Burger Chain",
"registrationTime": 1512828988826,
"email": "jsmith123@example.com",
"emailVerifiedTime": 1512828988826,
"name": "John Smith",
"telephone": "+16045555555",
"telephoneVerifiedTime": 1512828988826,
"telephoneCountry": "GBR",
"homeLocation": {
"country": "GBR",
"postalCode": "E1 1AA",
"latitude": 51.503252,
"longitude": -0.127899,
"addresseeName": "John Smith",
"street1": "123 fake st.",
"street2": "floor 4, flat 48",
"neighbourhood": "Hackney",
"zone": "1",
"city": "London",
"region": "California",
"poBoxNumber": "1234"
},
"taxAddress": {
"country": "GBR",
"postalCode": "E1 1AA",
"latitude": 51.503252,
"longitude": -0.127899,
"addresseeName": "John Smith",
"street1": "123 fake st.",
"street2": "floor 4, flat 48",
"neighbourhood": "Hackney",
"zone": "1",
"city": "London",
"region": "California",
"poBoxNumber": "1234"
},
"type": "driver",
"level": "gold",
"employmentType": "selfEmployed",
"transportType": "car",
"category": "private-hire",
"accountType": "INDIVIDUAL",
"accountPlatform": "anchor",
"identityVerified": false,
"tags": {
"foo": true,
"bar": false
}
},
"paymentMethod": {
"methodType": "card",
"paymentMethodId": "pm-abc123",
"scheme": "visa",
"instrumentId": "fp_abc123",
"cardBin": "535522",
"cardLastFour": "0001",
"expiryMonth": 7,
"expiryYear": 2020,
"eWallet": "applepay",
"nameOnCard": "John Smith",
"billingAddress": {
"country": "GBR",
"postalCode": "E1 1AA",
"latitude": 51.503252,
"longitude": -0.127899,
"addresseeName": "John Smith",
"street1": "123 fake st.",
"street2": "floor 4, flat 48",
"neighbourhood": "Hackney",
"zone": "1",
"city": "London",
"region": "California",
"poBoxNumber": "1234"
},
"corporateCard": true,
"virtualCard": true,
"successfulRegistration": true,
"registrationTime": 1512828988826,
"lastVerified": 1512828988826,
"compromised": true,
"compromisedReason": "stolen"
},
"paymentMethods": [
{
"methodType": "card",
"paymentMethodId": "pm-abc123",
"scheme": "visa",
"instrumentId": "fp_abc123",
"cardBin": "535522",
"cardLastFour": "0001",
"expiryMonth": 7,
"expiryYear": 2020,
"eWallet": "applepay",
"nameOnCard": "John Smith",
"billingAddress": {
"country": "GBR",
"postalCode": "E1 1AA",
"latitude": 51.503252,
"longitude": -0.127899,
"addresseeName": "John Smith",
"street1": "123 fake st.",
"street2": "floor 4, flat 48",
"neighbourhood": "Hackney",
"zone": "1",
"city": "London",
"region": "California",
"poBoxNumber": "1234"
},
"corporateCard": true,
"virtualCard": true,
"successfulRegistration": true,
"registrationTime": 1512828988826,
"lastVerified": 1512828988826,
"compromised": true,
"compromisedReason": "stolen"
}
]
}
Was this page helpful?
Thanks for the feedback. If you'd like to provide more detail you can share it in our Help Center.