Ödeme alma
Diğer müşterilerin size Alım Kodunuzla ödeme yapmasını sağlayın, paranın nereye ulaşacağını seçin ve gelen her ödemeyi izleyin.
Platformdaki diğer müşteriler, banka bilgilerinizi hiç görmeden size ödeme yapabilir. Onlara Alım Kodunuzu verirsiniz; sizi bu kodla alıcı olarak eklerler; gönderdikleri her ödemeyi siz de gelen ödeme olarak izlersiniz.
Nasıl çalışır
- Alım Kodu: size ödeme yapacak kişiye verdiğiniz
RC-7KQ2-M9XDgibi kısa bir kod. Aynı anda tek bir kod geçerlidir. - Alım Hesabı: doğrulanmış kendi banka hesaplarınızdan biri. Kodunuzla gönderilen ödemeler bu hesaba yatırılır.
- Gelen ödeme: başka bir müşterinin size gönderdiği ödeme, sizin gördüğünüz haliyle: kimin gönderdiği, ne kadar ulaşacağı ve nerede olduğu.
Gönderen, adınızı ve hesabınızın son dört karakterini görür. Siz, gönderenin adını ve alacağınız tutarı görürsünüz. İki taraf da bundan fazlasını görmez.
Ödeme almayı kurma
İki yazma çağrısı customer:beneficiaries:write iznine sahip bir API anahtarı ister; okuma customer:read ister. Hesabınız aktif olmalı.
Kendi hesabınızı kaydedin
Alıcılar sayfasındaki gibi own_account türünde, proof_reference ile bir alıcı oluşturun. Pakistan'da bir şirket olan Lina, şirketinin PKR hesabını kaydediyor. Hesap pending_verification olarak başlar; uyum ekibimiz belgeyi kontrol edip doğrular.
Alım Hesabınız olarak seçin
verified olduğunda PUT /v1/receiving/account ile seçin.
Kodunuzu alın
POST /v1/receiving/code bir kodu geçerli kılar. Önce hesap seçtiyseniz, kod onunla birlikte oluşturulur.
Kodu paylaşın
Gönderen, kodu POST /v1/beneficiaries/link ile girer. Bkz. Başka bir müşteriyi ekleme.
curl -X PUT "$APEX_BASE_URL/v1/receiving/account" \
-H "Authorization: Bearer $APEX_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "beneficiary_id": "e2b9c7a1-4d3f-4e8a-b6c5-1f0a9d8e7c62" }'
curl -X POST "$APEX_BASE_URL/v1/receiving/code" \
-H "Authorization: Bearer $APEX_API_KEY"GET /v1/receiving dahil üç çağrı da aynı görünümü döner:
{
"code": "RC-7KQ2-M9XD",
"account": {
"beneficiary_id": "e2b9c7a1-4d3f-4e8a-b6c5-1f0a9d8e7c62",
"name": "Lina Textiles Ltd",
"country": "PK",
"asset": "PKR",
"account_hint": "6789"
},
"credit_asset": ""
}| Alan | Anlamı |
|---|---|
code | Alım Kodunuz; henüz yoksa null. |
account | Alım Hesabınız; seçene kadar null. Seçtikten sonra engellenen bir hesap da null okunur. |
credit_asset | Doluysa, kodunuzla gönderilen ödemeler bu para biriminde platform bakiyenize eklenir. Değilse boştur. Aşağıya bakın. |
PUT /v1/receiving/account yalnızca size ait, verified durumundaki own_account alıcılarından birini kabul eder. Başka her şey receiving_account_invalid (422) döner.
Para nereye ulaşır
delivered_to | Ne olur |
|---|---|
bank_account | Ödeme Alım Hesabınıza yatırılır. Varsayılan budur. |
balance | Ödeme, kendi ülkenizin para biriminde platform bakiyenize eklenir. |
Bazı ülkelerde kodunuzla gönderilen ödemeler, hesabınıza yatırılmak yerine bakiyenize eklenir. GET /v1/receiving yanıtındaki credit_asset, bunun sizin için geçerli olup olmadığını söyler; örneğin "PKR". Bunu siz seçmezsiniz ve yalnızca kendi ülkeniz için geçerlidir:
credit_assetdoluysa, ödeme almak için Alım Hesabına ihtiyacınız yoktur. Hesap yalnızca bakiyeyi bankanıza çekmek için gerekir.- Alım Hesabınız bakiyeye eklenen para biriminden farklı bir ülkede ya da para birimindeyse ödemeler o hesaba gider ve
credit_assetboştur.
Bakiyenize eklenen bir ödeme, GET /v1/balances yanıtında para yatırma gibi görünür. Onu başkasına gönderebilir ya da sıradan bir ödemeyle kendi hesabınıza çekebilirsiniz. Bkz. Bakiyeler ve para yatırma.
Gönderen de aynı şeyi önceden görür: sizin için oluşturduğu alıcı delivers_to, ödemesi ise delivered_to taşır.
Gelen ödemeleri izleme
GET /v1/incoming-payouts size gönderilen ödemeleri en yenisi önce listeler. GET /v1/incoming-payouts/{id} tek bir ödemeyi döner. İkisi de customer:read ister.
curl "$APEX_BASE_URL/v1/incoming-payouts?limit=20" \
-H "Authorization: Bearer $APEX_API_KEY"{
"items": [
{
"id": "8d4f2b6a-0c1e-4a7b-9e3d-5f6a7b8c9d01",
"sender_name": "Tom Trading LLC",
"amount": { "amount": "277664.5", "asset": "PKR" },
"purpose": "supplier",
"status": "delivered",
"delivered_to": "bank_account",
"account_hint": "6789",
"created_at": "2026-11-12T10:00:20Z",
"delivered_at": "2026-11-12T12:01:30Z",
"updated_at": "2026-11-12T12:01:30Z"
}
],
"next_cursor": "MjAyNi0xMS0xMlQxMDowMDoyMFp8OGQ0ZjJiNmE"
}| Alan | Anlamı |
|---|---|
sender_name | Gönderen müşterinin, ödemeyi gönderdiği andaki yasal adı. |
amount | Alacağınız tutar. |
purpose | Gönderenin bildirdiği amaç: services, payroll, supplier, goods ya da digital_goods. |
status | Ödemenin nerede olduğu; aşağıya bakın. |
delivered_to | bank_account ya da balance. |
account_hint | Paranın yatırılacağı hesabın son dört karakteri. balance için boştur. |
delivered_at | Hesabınıza ya da bakiyenize ulaştığı an; o zamana kadar null. |
Sayfalama GET /v1/payouts ile aynıdır: limit 1 ile 100 arası (varsayılan 50), cursor ise önceki sayfanın next_cursor değeri; son sayfada next_cursor gelmez.
Durumlar
status | Anlamı |
|---|---|
on_the_way | Yolda: gönderenin parası ayrıldı ve ödeme size doğru yolda. |
delivered | Teslim edildi: hesabınıza yatırıldı ya da bakiyenize eklendi. |
delayed | Gecikti: beklenenden uzun sürüyor. Operasyon ekibimiz ilgileniyor; yine de ulaşabilir ya da iade edilebilir. Sizin yapmanız gereken bir şey yok. |
returned | İade edildi: gönderene döndü ve size ulaşmayacak. Bekliyorsanız gönderene sorun. |
Bir ödeme ancak gönderenin parası onun için ayrıldığında görünür. Gönderenin kendi onayını ya da parasını beklerken ve gönderen onu bu aşamada iptal ederse, ödemeyi hiç görmezsiniz. Gönderenin ne ödediğini, ücretleri, rotayı ya da Provider'ları hiçbir zaman görmezsiniz. Size görünür bir gelen ödeme olmayan her kimlik payout_not_found (404) döner.
Bildirimler
- Webhook: bir uç noktayı
payout.incoming.updatedolayına abone edin.statusher değiştiğinde yukarıdaki gelen ödemeyi alırsınız. Bkz. Webhook'lar. - E-posta: bir ödeme teslim edildiğinde ekibinize gönderen, tutar ve paranın nereye ulaştığını bildiren bir e-posta gider.
Kodunuzu değiştirme
POST /v1/receiving/code çağrısını yeniden yapın. Eski kod yeni gönderenler için hemen çalışmaz olur. Sizi daha önce ekleyen müşteriler eskisi gibi ödeme yapmaya devam eder. Kodunuz yanlış ellere geçtiyse ya da yeni gönderenlerin sizi onunla bulmasını istemiyorsanız değiştirin.
Hatalar
| Kod | Durum | Nedeni |
|---|---|---|
receiving_account_invalid | 422 | Alıcı, size ait ve doğrulanmış bir own_account değil. |
payout_not_found | 404 | Bu kimlikle size görünür bir gelen ödeme yok. |
bad_limit, bad_cursor | 422 | limit 1 ile 100 arasında değil ya da cursor bu API'nin döndüğü bir değer değil. |
customer_suspended | 403 | Hesabınız askıda; yalnızca okuyabilir. |
customer_not_active | 403 | Hesabınız henüz açılmadı ya da kapalı. |