Payout

POST api.ravelin.com/v2/payout

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.

Show all definitions
timestamp integer required

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 1970-01-01T00:00 UTC (nanoseconds are also accepted).

payout object required

The payout describing the earnings that a merchant is intended to pay to the supplier on their platform.

Show definition
supplier object required

The supplier that is set as the recipient of this payout.

Show definition
eventType string optional

An eventType should identify what event in your system triggered this API call.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*$
paymentMethod object important

A primary payout method for funds to be transferred in by the merchant.

One of the following:

Card - A credit or debit card.

Show definition

Payment Method Cipher - An encrypted payment method, containing the full card details encrypted via a Ravelin SDK.

Show definition

Cash - The customer is paying in cash, or a cash-based payment method.

Show definition

Bank Account - Bank Accounts.

Show definition

PayPal - PayPal payments.

Show definition

Credit - This payment method type should be used for any payments made using credit that a customer has with the merchant.

Show definition

Invoice - This payment method should be used whenever the merchant provides credit to the customer.

Show definition

Wallet - A digital wallet payment method.

Show definition

From Transaction - Refer to the payment method used by a named transaction. For usage examples, see Saving payment methods after checkout and Associating refunds with payment methods.

Show definition

Direct Debit - Direct Debits. - deprecated.

Show definition

Bank Transfer - Bank Transfers. - deprecated.

Show definition

Other - Other supported payment methods. - deprecated.

Show definition

Removal: Used for marking a saved payment method as removed from the account.

Show definition
paymentMethods array optional
deprecated

A primary payout method for funds to be transferred in by the merchant.

One of the following:

Card - A credit or debit card.

Show definition

Payment Method Cipher - An encrypted payment method, containing the full card details encrypted via a Ravelin SDK.

Show definition

Cash - The customer is paying in cash, or a cash-based payment method.

Show definition

Bank Account - Bank Accounts.

Show definition

PayPal - PayPal payments.

Show definition

Credit - This payment method type should be used for any payments made using credit that a customer has with the merchant.

Show definition

Invoice - This payment method should be used whenever the merchant provides credit to the customer.

Show definition

Wallet - A digital wallet payment method.

Show definition

From Transaction - Refer to the payment method used by a named transaction. For usage examples, see Saving payment methods after checkout and Associating refunds with payment methods.

Show definition

Direct Debit - Direct Debits. - deprecated.

Show definition

Bank Transfer - Bank Transfers. - deprecated.

Show definition

Other - Other supported payment methods. - deprecated.

Show definition

Removal: Used for marking a saved payment method as removed from the account.

Show definition
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,
    "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",
    "eWallet": "applepay"
  },
  "paymentMethods": [
    {
      "methodType": "card",
      "paymentMethodId": "pm-abc123",
      "scheme": "visa",
      "instrumentId": "fp_abc123",
      "cardBin": "535522",
      "cardLastFour": "0001",
      "expiryMonth": 7,
      "expiryYear": 2020,
      "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",
      "eWallet": "applepay"
    }
  ]
}

Feedback

© Ravelin Technology Ltd. All rights reserved