İçeriğe geç
Apex Settlement
Receiving

Choose the Receiving Account

Gereken izincustomer:beneficiaries:writeAPI referansındaki uç nokta açıklamaları İngilizcedir.
PUT
/v1/receiving/account

Names which of the Customer's verified own_account Beneficiaries the Payouts other Customers send it are paid into.

Requires the customer:beneficiaries:write permission. A Platform may call it for one of its End Customers with Apex-End-Customer.

Yetkilendirme

ApiKey
headerYetkilendirmeBearer <API key>

A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.

Başlık parametreleri

Apex-End-Customer?string

A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers end_customer_not_found.

Biçimuuid

İstek gövdesi

The account.

application/json
  1. body
beneficiary_id*string

Yanıt gövdesi

OK

application/json
  1. response
account*|

account is the Receiving Account, null until one is chosen.

code*|

code is the Receiving Code in force, null until the Customer has one.

credit_asset*string

credit_asset is the asset Payouts from other Customers are credited to the balance in, where the platform offers that in the Customer's country; empty where they are paid to the Receiving Account.

Örnek istek
curl -X PUT 'http://localhost:3480/v1/receiving/account' \  -H 'Content-Type: application/json' \  -d '{  "beneficiary_id": "8c2d5e3f-0a4b-4c9d-8e7f-6a5b4c3d2e1f"}'
Örnek yanıt
{  "account": {    "account_hint": "4321",    "asset": "PKR",    "beneficiary_id": "8c2d5e3f-0a4b-4c9d-8e7f-6a5b4c3d2e1f",    "country": "PK",    "name": "Lina Qureshi"  },  "code": "RC-7KQ2-M9XD",  "credit_asset": "PKR"}