Operations
Method Reference
Select language to view method names and signatures for that SDK.
Language
Auth and Account
| Method | Signature | Purpose |
|---|---|---|
| account_get_balances account_get_balances AccountGetBalancesAsync | (?string $currency_code = null, ?AccountGetBalancesFilter $filter = null): AccountGetBalancesResponse (currency_code: str | None = None, *, filter: AccountGetBalancesFilter | None = None) -> AccountGetBalancesResponse Task<AccountGetBalancesResponse> (string? currencyCode = null, AccountGetBalancesFilter? filter = null, CancellationToken cancellationToken = default) | Fetch account balances. |
| auth_change_password auth_change_password AuthChangePasswordAsync | (?array $variables = null): ModelBase (variables: Mapping[str, Any] | None = None) -> ModelBase Task<AuthChangePasswordResponse> (IReadOnlyDictionary<string, object>? variables = null, CancellationToken cancellationToken = default) | Authentication password change operation. |
| auth_get_token auth_get_token AuthGetTokenAsync | (string $username, string $password): AuthGetTokenResponse (username: str, password: str) -> AuthGetTokenResponse Task<AuthGetTokenResponse> (string username, string password, CancellationToken cancellationToken = default) | Get bearer token for API calls. |
Payin Hosted
| Method | Signature | Purpose |
|---|---|---|
| payin_hosted_create_transaction payin_hosted_create_transaction PayinHostedCreateTransactionAsync | (PayinCreateTransactionInput $transaction): PayinHostedCreateTransactionResponse (transaction: PayinCreateTransactionInput) -> PayinHostedCreateTransactionResponse Task<PayinHostedCreateTransactionResponse> (PayinCreateTransactionInput transaction, CancellationToken cancellationToken = default) | Create hosted payin transaction. |
| payin_hosted_get_transactions payin_hosted_get_transactions PayinHostedGetTransactionsAsync | (?PayinGetTransactionsQuery $query = null): PayinHostedGetTransactionsResponse (query: PayinGetTransactionsQuery | None = None) -> PayinHostedGetTransactionsResponse Task<PayinHostedGetTransactionsResponse> (PayinGetTransactionsQuery? query = null, CancellationToken cancellationToken = default) | List hosted payin transactions. |
| payin_hosted_get_transaction_by_reference payin_hosted_get_transaction_by_reference PayinHostedGetTransactionByReferenceAsync | (string $reference): PayinHostedGetTransactionByReferenceResponse (reference: str) -> PayinHostedGetTransactionByReferenceResponse Task<PayinHostedGetTransactionByReferenceResponse> (string reference, CancellationToken cancellationToken = default) | Fetch hosted transaction by merchant reference. |
| payin_hosted_get_transaction_by_internal_ref payin_hosted_get_transaction_by_internal_ref PayinHostedGetTransactionByInternalRefAsync | (string $internal_ref): PayinHostedGetTransactionByInternalRefResponse (internal_ref: str) -> PayinHostedGetTransactionByInternalRefResponse Task<PayinHostedGetTransactionByInternalRefResponse> (string internalRef, CancellationToken cancellationToken = default) | Fetch hosted transaction by Payyd internalRef. |
| payin_hosted_cancel_transaction payin_hosted_cancel_transaction PayinHostedCancelTransactionAsync | (PayinCancelTransactionInput $cancel): PayinHostedCancelTransactionResponse (cancel: PayinCancelTransactionInput) -> PayinHostedCancelTransactionResponse Task<PayinHostedCancelTransactionResponse> (PayinCancelTransactionInput cancel, CancellationToken cancellationToken = default) | Cancel hosted transaction. |
Payin S2S
| Method | Signature | Purpose |
|---|---|---|
| payin_s2s_create_transaction payin_s2s_create_transaction PayinS2sCreateTransactionAsync | (PayinCreateTransactionInput $transaction): PayinS2sCreateTransactionResponse (transaction: PayinCreateTransactionInput) -> PayinS2sCreateTransactionResponse Task<PayinS2sCreateTransactionResponse> (PayinCreateTransactionInput transaction, CancellationToken cancellationToken = default) | Create S2S transaction. |
| payin_s2s_get_transactions payin_s2s_get_transactions PayinS2sGetTransactionsAsync | (?PayinGetTransactionsQuery $query = null): PayinS2sGetTransactionsResponse (query: PayinGetTransactionsQuery | None = None) -> PayinS2sGetTransactionsResponse Task<PayinS2sGetTransactionsResponse> (PayinGetTransactionsQuery? query = null, CancellationToken cancellationToken = default) | List S2S transactions. |
| payin_s2s_get_transaction_by_reference payin_s2s_get_transaction_by_reference PayinS2sGetTransactionByReferenceAsync | (string $reference): PayinS2sGetTransactionByReferenceResponse (reference: str) -> PayinS2sGetTransactionByReferenceResponse Task<PayinS2sGetTransactionByReferenceResponse> (string reference, CancellationToken cancellationToken = default) | Get S2S transaction by reference. |
| payin_s2s_get_transaction_by_internal_ref payin_s2s_get_transaction_by_internal_ref PayinS2sGetTransactionByInternalRefAsync | (string $internal_ref): PayinS2sGetTransactionByInternalRefResponse (internal_ref: str) -> PayinS2sGetTransactionByInternalRefResponse Task<PayinS2sGetTransactionByInternalRefResponse> (string internalRef, CancellationToken cancellationToken = default) | Get S2S transaction by internalRef. |
| payin_s2s_get_payment_methods payin_s2s_get_payment_methods PayinS2sGetPaymentMethodsAsync | (string $country_iso_code3): PayinS2sGetPaymentMethodsResponse (country_iso_code3: str) -> PayinS2sGetPaymentMethodsResponse Task<PayinS2sGetPaymentMethodsResponse> (string countryIsoCode3, CancellationToken cancellationToken = default) | Fetch S2S payment methods by country ISO3. |
| payin_s2s_get_identification_types payin_s2s_get_identification_types PayinS2sGetIdentificationTypesAsync | (string $country_iso_code3): PayinS2sGetIdentificationTypesResponse (country_iso_code3: str) -> PayinS2sGetIdentificationTypesResponse Task<PayinS2sGetIdentificationTypesResponse> (string countryIsoCode3, CancellationToken cancellationToken = default) | Fetch S2S identification types by country ISO3. |
| payin_s2s_pay_transaction payin_s2s_pay_transaction PayinS2sPayTransactionAsync | (PayinS2sPayTransactionInput $transaction): PayinS2sPayTransactionResponse (transaction: PayinS2sPayTransactionInput) -> PayinS2sPayTransactionResponse Task<PayinS2sPayTransactionResponse> (PayinS2sPayTransactionInput transaction, CancellationToken cancellationToken = default) | Submit S2S pay payload. |
| payin_s2s_cancel_transaction payin_s2s_cancel_transaction PayinS2sCancelTransactionAsync | (PayinCancelTransactionInput $cancel): PayinS2sCancelTransactionResponse (cancel: PayinCancelTransactionInput) -> PayinS2sCancelTransactionResponse Task<PayinS2sCancelTransactionResponse> (PayinCancelTransactionInput cancel, CancellationToken cancellationToken = default) | Cancel S2S transaction. |
Payout
| Method | Signature | Purpose |
|---|---|---|
| payout_create_transaction payout_create_transaction PayoutCreateTransactionAsync | (PayoutCreateTransactionInput $transaction): PayoutCreateTransactionResponse (transaction: PayoutCreateTransactionInput) -> PayoutCreateTransactionResponse Task<PayoutCreateTransactionResponse> (PayoutCreateTransactionInput transaction, CancellationToken cancellationToken = default) | Create payout transaction. |
| payout_get_transaction payout_get_transaction PayoutGetTransactionAsync | (string $reference): PayoutGetTransactionResponse (reference: str) -> PayoutGetTransactionResponse Task<PayoutGetTransactionResponse> (string reference, CancellationToken cancellationToken = default) | Get payout transaction by reference. |
| payout_get_transactions payout_get_transactions PayoutGetTransactionsAsync | (?PayoutGetTransactionsQuery $query = null): PayoutGetTransactionsResponse (query: PayoutGetTransactionsQuery | None = None) -> PayoutGetTransactionsResponse Task<PayoutGetTransactionsResponse> (PayoutGetTransactionsQuery? query = null, CancellationToken cancellationToken = default) | List payout transactions. |
| payout_get_banks payout_get_banks PayoutGetBanksAsync | (PayoutGetBanksQuery $query): PayoutGetBanksResponse (query: PayoutGetBanksQuery) -> PayoutGetBanksResponse Task<PayoutGetBanksResponse> (PayoutGetBanksQuery query, CancellationToken cancellationToken = default) | Fetch available banks for payout country. |
| payout_get_fx_rate payout_get_fx_rate PayoutGetFxRateAsync | (PayoutGetFxRateQuery $query): PayoutGetFxRateResponse (query: PayoutGetFxRateQuery) -> PayoutGetFxRateResponse Task<PayoutGetFxRateResponse> (PayoutGetFxRateQuery query, CancellationToken cancellationToken = default) | Get payout FX quote. |