Transfer API v2024-06-01 Kullanım Örneği Kılavuzu
Transferler API'sini kullanarak ödeme yöntemleri nasıl alınır ve ödemeler nasıl başlatılır.
API Sürümü: v2020-07-01
This guide describes how to use the Transfers API v2024-06-01 to retrieve the seller's payment methods and request a payout of an available balance for the given marketplace and account type.
Transferler API'si nedir?
Satıcılar şunları kullanabilir Transfer API'si v2024-06-01 Bir satıcıyla ilişkili ödeme yöntemleri hakkında bilgi almak ve satıcının dosyadaki para yatırma yöntemine ödeme başlatmak için.
Eğitim 1: Bir satıcıyla ilişkili ödeme yöntemi ayrıntılarını alma
Bu eğitim, belirli bir pazar yeri için satıcı tarafından eklenen ödeme yöntemlerinin listesinin nasıl alınacağını gösterir..
Ön koşullar
Bu eğitici içeriği başarıyla tamamlamak için şunlara ihtiyacınız olacak:
- Arama yaptığınız satış ortağından izin. Daha fazla bilgi için bkz. Satış Ortağı API uygulamalarını yetkilendirme.
- Onay Finans ve Muhasebe rolü geliştirici profilinizde.
- Finans ve Muhasebe rolü uygulamanız için uygulama kayıt sayfasında seçildi.
Adım 1. Belirli bir pazardaki bir satıcıyla ilişkili ödeme yöntemlerinin ayrıntılarını alın
Aşağıdaki parametrelerle getPaymentMethods
işlemini çağırın:
Sorgu parametreleri
Ad | Açıklama | Schema | Zorunlu mu? |
---|---|---|---|
marketplaceId | Ödeme yöntemlerini almak istediğiniz pazarın tanımlayıcısı. Pazarınızın kimliğini bulmak için bkz. Pazar yeri kimlikleri. | string | Evet |
paymentMethodTypes | Yanıta dahil etmek istediğiniz ödeme yöntemi türlerinin virgülle ayrılmış bir listesi. | < dizi > sıra | Hayır |
İstek örnekleri
GET /finances/transfers/2024-06-01/paymentMethods?marketplaceId=ATVPDKIKX0DER
GET /finances/transfers/2024-06-01/paymentMethods?marketplaceId=ATVPDKIKX0DER?paymentMethodTypes=BANK_ACCOUNT,CARD
Yanıt
Ad | Açıklama | Schema |
---|---|---|
accountHolderName | Ödeme yöntemi için kayıtlı olan hesap sahibinin adı. | string |
paymentMethodId | Ödeme yönteminin tanımlayıcısı. | string |
paymentMethodType | Ödeme yöntemi türü. | PaymentMethodType |
tail | Ödeme yönteminin son üç veya dört basamağı. | string |
assignmentType | Varsayılan ödeme yöntemi türü. Bu alan eşittir DEFAULT_DEPOSIT_METHOD ödeme yöntemi varsayılan para yatırma yönteminizse. | AssignmentType |
countryCode | İki harfli ülke kodu ISO 3166-1 alfa-2 biçim. İçindeki ödeme yöntemleri için CARD kategori, kod kartın verildiği ülke içindir. İçindeki ödeme yöntemleri için BANK_ACCOUNT kategori, kod hesabın bulunduğu ülke içindir. | string |
expiryDate | Ödemeler için kullanılan kartın son kullanma tarihi. | ExpiryDate |
Yanıt örneği
{
"paymentMethods": [
{
"accountHolderName": "John Doe",
"paymentMethodId": "0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d",
"paymentMethodType": "BANK_ACCOUNT",
"tail": "677",
"assignmentType": "DEFAULT_DEPOSIT_METHOD",
"countryCode": "UK"
},
{
"accountHolderName": "John Doe",
"paymentMethodId": "0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d",
"paymentMethodType": "BANK_ACCOUNT",
"tail": "677",
"countryCode": "DE"
}
]
}
Eğitim 2: Ödeme başlatın
Bu eğitim, satıcının para yatırma yöntemine nasıl ödeme yapılacağını gösterir. 24 saatlik bir süre içinde her pazar yeri ve hesap türü için yalnızca bir isteğe bağlı ödeme başlatılabilir.
Ön koşullar
Bu eğitici içeriği başarıyla tamamlamak için şunlara ihtiyacınız olacak:
- Arama yaptığınız satış ortağından izin. Daha fazla bilgi için bkz. Satış Ortağı API uygulamalarını yetkilendirme.
- Onay Finans ve Muhasebe rolü geliştirici profilinizde.
- Finans ve Muhasebe rolü uygulamanız için uygulama kayıt sayfasında seçildi.
Adım 1. Ödeme başlatın
Arayın initiatePayout
operasyon. İstek tiptedir InitiatePayoutRequest
ve aşağıdaki parametreleri içerir:
Gövde parametreleri
Ad | Açıklama | Schema | Zorunlu mu? |
---|---|---|---|
marketplaceId | Bir pazar yeri tanımlayıcısı. Yalnızca aşağıdaki pazarlarda desteklenir: ES, FR, BE, NL, DE, IT, SE, PL (bkz. Pazar yeri kimlikleri). | string | Evet |
accountType | Seçilen pazardaki ödemenin başlatılması gereken hesap türü. Desteklenen AB pazarları için tek hesap türü Standard Orders . | string | Evet |
İstek örneği
POST finances/transfers/2024-06-01/payouts/
{
"marketplaceId": "A1PA6795UKMFR9",
"accountType": "Standard Orders"
}
Yanıt
Başarılı bir yanıtta aşağıdakiler yer alır:
Ad | Açıklama | Schema |
---|---|---|
payoutReferenceId | Başarılı bir ödeme başlatma sonucu şunları içerir: payoutReferenceId ödeme bilgilerini izlemek için satış ortakları tarafından kullanılabilir. Başlatılan bir ödemenin finansal olay grubu kimliğidir. | string |
Yanıt örneği
{
"payoutReferenceId": "3DM7DQi8DPAMOLOSaN5HxT0q2waNwH95fopx3XXXXxx"
}
Hata yanıtı
Başarısız bir yanıt, ödemenin başlatılmamasının nedenlerini açıklayan bir hata listesi içerir.
Hata | Açıklama | Schema |
---|---|---|
code required | Oluşan hata türünü tanımlayan bir hata kodu. Örnek: "InvalidInput" | string |
message required | Hata durumunu insan tarafından okunabilen bir biçimde açıklayan bir ileti. Örnek: "The input request had one or more invalid input parameters." | string |
details optional | Arayanın sorunu anlamasına veya düzeltmesine yardımcı olabilecek ek ayrıntılar. Örnek: "The following input parameters are invalid : [marketplaceId]." | string |
Hata Yanıtı örneği:
{
"errors": [
{
"code": "NoDepositMethod",
"message": "Deposit method is missing, invalid or not assigned."
},
{
"code": "InsufficientPayoutAmount",
"message": "Available balance is below the minimum allowed payout amount."
}
]
}
2 ay önce güncellendi