KOkoin
Payout Services

Create Payout

Changed on

In the payout service creation, all the required fields will be validated at first, after that, business validation rules will be run. The next table shows the information about the API.

post/v1/payment/payouts

Request

  • Base URL
    https://api-sandbox.koin.com.br
  • URL
    https://api-sandbox.koin.com.br/v1/payment/payouts
  • Auth
    none declared. Required headers: Content-Type, Accept

Headers

Content-Typestring required

The Media type of the body of the request. Default value for payment provider protocol is application/json

Acceptstring required

Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json

Request body

OR

Example request

{
  "store": {
    "code": "SBXSTORE"
  },
  "transaction": {
    "reference_id": "REF0000001",
    "business_id": "BIZ0000001",
    "account": "SBX000PO",
    "amount": {
      "currency_code": "BRL"
    }
  },
  "payment_method": {
    "code": "PAYOUTS",
    "recipient": {
      "full_name": "Box Jhon",
      "account": {
        "code": "0123456789",
        "type": "CC"
      }
    }
  },
  "notification_url": [
    "https://www.providerApi.com/notificationPayouts"
  ],
  "descriptor": "From Mike to Maria's birthday present"
}

Response

Create payout response

OR

Example response

{
  "store": {
    "code": "SBXSTORE"
  },
  "descriptor": "From Mike to Maria's birthday present",
  "transaction": {
    "reference_id": "REF0000001",
    "business_id": "BIZ0000001",
    "account": "SBX000PO",
    "amount": {
      "currency": "btc"
    }
  },
  "payment_method": {
    "code": "PAYOUTS",
    "recipient": {
      "full_name": "Box Jhon",
      "account": {
        "code": "0123456789",
        "type": "CC"
      }
    }
  },
  "payout_id": "5t1bc9001-6b5a-4f21-b5ee-fd32m4f436c6"
}

Changes

  • 1e3734785750Revision changes
    • warning

      changed the pattern of the request property /// from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2}

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      the /// response's property pattern was changed from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2} for the status