Settlement
Home Settlement Settlement Account Info Settlement Account Info Fetch settlement account information including bank details, balance, and settlement schedule.
Generate an API Key for Payment Link channel: Navigate to Developers → API Keys → Add new API key → Select HOSTED in the Channel Dropdown.
Method URL GET https://api.payorc.com/settlements/v1/info?mid_label=labelname
Settlement APIs are available in live mode only . Requests made with test/sandbox credentials return Settlement is not available for test mode. Use your live merchant-key and merchant-secret.
Field Type Description merchant-key String Your merchant key (e.g. live-D111PIS13YK) merchant-secret String Your merchant secret (e.g. sec-JI11G0P13Z0)
Field Type Required Description mid_label String Yes The MID Label name. Returns mid_label is required if omitted, Invalid MID Label if no matching MID is found, and Settlement is not Enabled for this MID if the MID has no settlement account configured.
curl -X GET "https://api.payorc.com/settlements/v1/info?mid_label=my-store" \ -H "merchant-key: live-XXXXXXXXXX" \ -H "merchant-secret: sec-XXXXXXXXXX"
{ "data" : { "settlement_information" : { "current_balance" : "AED 5000.00" , "interval" : "T+1" , "next_payment" : "2025-04-16" , "min_payout_amount" : "AED 100.00" , "payout_fee" : "AED 2.00" }, "bank_information" : { "bank" : "Emirates NBD" , "bank_account_name" : "My Store LLC" , "bank_account_number" : "12******90" , "iban" : "AE12****************9012" , "swift" : "EBILAEAD" }, "totalSettledAmount" : "AED 150000.00" , "lastSettledAmount" : "AED 5000.00" , "totalSettlementInProgress" : "AED 2000.00" , "upcomingAmount" : "AED 3000.00" }, "message" : "success" , "status" : "success" , "code" : "00" }
Amount fields are returned as currency-prefixed strings (e.g. AED 5000.00); there is no separate currency field. bank_account_number and iban are masked. current_balance, interval, and next_payment are sourced from the settlement provider.
Field Type Description current_balance String Current balance, currency-prefixed (e.g. AED 5000.00) interval String Settlement interval (e.g. T+1) next_payment String Next payment date min_payout_amount String Minimum payout amount, currency-prefixed payout_fee String Fee per payout transaction, currency-prefixed
Field Type Description bank String Name of the bank bank_account_name String Name on the bank account bank_account_number String Bank account number (masked) iban String IBAN for the bank account (masked) swift String SWIFT code for international transactions
Field Type Description totalSettledAmount String Total amount settled so far, currency-prefixed lastSettledAmount String Most recent settled amount, currency-prefixed totalSettlementInProgress String Total amount currently in settlement process, currency-prefixed upcomingAmount String Upcoming amount to be settled, currency-prefixed
